On a given volume, reclaims memory used by purgeable icons.

OSErr FlushIconRefsByVolume (
    SInt16 vRefNum
);

vRefNum

The volume whose icon cache is to be flushed.

function result

A result code.

DISCUSSION

Calling this function locks the bitmap data of all IconRefs with non-zero reference counts (that is, all IconRefs that are in use) on the volume. The Finder normally maintains a number of IconRefs with non-zero reference counts, so you should use the function FlushIconRefs instead of the FlushIconRefsByVolume function whenever feasible.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when IconServicesLib 8.5 or later is installed. Exported by CarbonLib 1.0 and later and by IconServicesLib 8.5 and later.

© 2000 Apple Computer, Inc. — (Last Updated 4/18/2000)